GET api/properties/{propertyId}/violations?status={status}&action[0]={action[0]}&action[1]={action[1]}&sort={sort}&page={page}&pageSize={pageSize}
Get all violations for a property.
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| propertyId |
(Required) |
integer |
Required |
| status |
(Optional) Limits the results by status. If no status filter is applied all violations are retuned. The possible values are: open, closed. |
string | |
| action |
(Optional)Limits the results by violation action ids. |
Collection of integer |
None. |
| sort |
(Optional)The order in which to sort the returned violations. Defaults to unitdisplayorder ascending. The possible values are: unitdisplayorder and violationdate |
string | |
| page |
(Optional)The page number of returned records based on the page size |
integer |
0 |
| pageSize |
(Optional)The number of records to return per page |
integer |
0 |
Body Parameters
None.
Response Information
Resource Description
ListWrapperOfViolation| Name | Description | Type | Additional information |
|---|---|---|---|
| Total | integer |
None. |
|
| Elements | Collection of Violation |
None. |
Response Formats
application/json, text/json
Sample:
{
"Total": 1,
"Elements": [
{
"ViolationId": 1,
"PropertyId": 1,
"UnitId": 1,
"ActionId": 1,
"SubCategoryId": 1,
"ViolationDate": "2025-12-24T05:27:29.768479-05:00",
"FineCents": "sample string 2",
"FineAmount1": "sample string 3",
"FineAmount2": "sample string 4",
"FineAmount3": "sample string 5",
"FineAmount4": "sample string 6",
"FineMax": "sample string 7",
"FineIncrementAmount": "sample string 8",
"FineIncrement": "sample string 9",
"ActionDate": "2025-12-24T05:27:29.768479-05:00",
"Comment": "sample string 10",
"CorrectInDays": 1,
"ViolationNotes": "sample string 11",
"VioLastinspectionDate": "2025-12-24T05:27:29.768479-05:00",
"FineScheduleType": 12,
"PayFineDate": "2025-12-24T05:27:29.768479-05:00"
},
{
"ViolationId": 1,
"PropertyId": 1,
"UnitId": 1,
"ActionId": 1,
"SubCategoryId": 1,
"ViolationDate": "2025-12-24T05:27:29.768479-05:00",
"FineCents": "sample string 2",
"FineAmount1": "sample string 3",
"FineAmount2": "sample string 4",
"FineAmount3": "sample string 5",
"FineAmount4": "sample string 6",
"FineMax": "sample string 7",
"FineIncrementAmount": "sample string 8",
"FineIncrement": "sample string 9",
"ActionDate": "2025-12-24T05:27:29.768479-05:00",
"Comment": "sample string 10",
"CorrectInDays": 1,
"ViolationNotes": "sample string 11",
"VioLastinspectionDate": "2025-12-24T05:27:29.768479-05:00",
"FineScheduleType": 12,
"PayFineDate": "2025-12-24T05:27:29.768479-05:00"
}
]
}
Internal Error Codes
-
106: ResourceNotFound
(The requested resource was not found., NotFound) -
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest) -
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest) -
199: UnknownError
(Internal server error., InternalServerError) -
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)